1. Getting started with PowerShell¶
Note
The below information is extensively based in information taken from the PowerShell® Notes for Professionals book. I plan to extend this information based on my day to day usage of the language.
Powershell versions¶
| Version | Included out of the box with: |
|---|---|
| 1.0 | Windows XP / Server 2008 |
| 2.0 | Windows 7 / Server 2008 R2 |
| 3.0 | Windows 8 / Server 2012 |
| 4.0 | Windows 8.1 / Server 2012 R2 |
| 5.0 | Windows 10 / Server 2016 Tech Preview |
| 5.1 | Windows 10 Anniversary edition / Server 2016 |
1.1: Allow scripts stored on your machine to run un-signed¶
For security reasons, PowerShell is set up by default to only allow signed scripts to execute. Executing the following command will allow you to run unsigned scripts (you must run PowerShell as Administrator to do this).
1 | Set-ExecutionPolicy RemoteSigned |
Another way to run PowerShell scripts is to use Bypass as ExecutionPolicy:
1 | powershell.exe -ExecutionPolicy Bypass -File "c:\MyScript.ps1" |
Or from within your existing PowerShell console or ISE session by running:
1 | Set-ExecutionPolicy Bypass Process |
A temporary workaround for execution policy can also be achieved by running the PowerShell executable and passing any valid policy as -ExecutionPolicy parameter. The policy is in effect only during process' lifetime, so no administrative access to the registry is needed.
1 | powershell.exe -ExecutionPolicy RemoteSigned |
There are multiple other policies available, and sites online often encourage you to use Set-ExecutionPolicy Unrestricted. This policy stays in place until changed, and lowers the system security stance. This is not advisable.
Use of RemoteSigned is recommended because it allows locally stored and written code, and requires remotely acquired code be signed with a certificate from a trusted root.
Also, beware that the Execution Policy may be enforced by Group Policy, so that even if the policy is changed to
Unrestricted system-wide, Group Policy may revert that setting at its next enforcement interval (typically 15 minutes). You can see the execution policy set at the various scopes using Get-ExecutionPolicy
1.2: Aliases & Similar Functions¶
In PowerShell, there are many ways to achieve the same result. This can be illustrated nicely with the simple & familiar Hello World example:
Using Write-Host :
1 | Write-Host "Hello World" |
Using Write-Output :
1 | Write-Output 'Hello world' |
It's worth noting that although Write-Output & Write-Host both write to the screen there is a subtle difference.
Write-Host writes only to stdout (i.e. the console screen), whereas Write-Output writes to both stdout AND to the output [success] stream allowing for redirection. Redirection (and streams in general) allow for the output of one command to be directed as input to another including assignment to a variable.
1 2 3 | $message = Write-Output "Hello World" $message "Hello World" |
These similar functions are not aliases, but can produce the same results if one wants to avoid "polluting" the success stream.
Write-Output is aliased to Echo or Write
1 2 | Echo 'Hello world' Write 'Hello world' |
Or, by simply typing 'Hello world'!
1 | 'Hello world'
|
All of which will result with the expected console output
1 | Hello world |
Another example of aliases in PowerShell is the common mapping of both older command prompt commands and BASH commands to PowerShell cmdlets. All of the following produce a directory listing of the current directory.
1 2 3 | dir ls Get-ChildItem |
Finally, you can create your own alias with the Set-Alias cmdlet! As an example let's alisas Test-NetConnection, which is essentially the PowerShell equivalent to the command prompt's ping command, to "ping".
1 | Set-Alias -Name ping -Value Test-NetConnection |
Now you can use ping instead of Test-NetConnection! Be aware that if the alias is already in use, you'll overwrite the association.
The Alias will be alive, till the session is active. Once you close the session and try to run the alias which you have created in your last session, it will not work. To overcome this issue, you can import all your aliases from an excel into your session once, before starting your work.
1.3: The Pipeline - Using Output from a PowerShell¶
One of the first questions people have when they begin to use PowerShell for scripting is how to manipulate the output from a cmdlet to perform another action.
The pipeline symbol | is used at the end of a cmdlet to take the data it exports and feed it to the next cmdlet. A simple example is using Select-Object to only show the Name property of a file shown from Get-ChildItem:
1 2 3 | Get-ChildItem | Select-Object Name #This may be shortened to: gci | Select Name |
More advanced usage of the pipeline allows us to pipe the output of a cmdlet into a foreach loop:
1 2 3 | Get-ChildItem | ForEach-Object { Copy-Item -Path $_.FullName -destination C:\NewDirectory\ } |
1 2 | #This may be shortened to: gci | % { Copy $_.FullName C:\NewDirectory\ } |
Note that the example above uses the $_ automatic variable. $_ is the short alias of $PSItem which is an automatic variable which contains the current item in the pipeline.
1.4: Calling .Net Library Methods¶
Static .Net library methods can be called from PowerShell by encapsulating the full class name in third bracket and then calling the method using ::
1 2 3 | #calling Path.GetFileName() [System.IO.Path]::GetFileName('C:\Windows\explorer.exe') explorer.exe |
Static methods can be called from the class itself, but calling non-static methods requires an instance of the .Net class (an object).
For example, the AddHours method cannot be called from the System.DateTime class itself. It requires an instance of the class:
1 2 3 4 5 6 7 | [System.DateTime]::AddHours( 15 ) Method invocation failed because [System.DateTime] does not contain a method named 'AddHours'. At line: 1 char: 1 + [System.DateTime]::AddHours( 15 ) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : MethodNotFound |
In this case, we first create an object, for example:
1 | $Object = [System.DateTime]::Now |
Then, we can use methods of that object, even methods which cannot be called directly from the System.DateTime class, like the AddHours method:
1 | $Object.AddHours( 15 ) |
1 | Monday 12 September 2016 01: 51 : 19 |
1.5: Installation or Setup¶
Windows
PowerShell is included with the Windows Management Framework. Installation and Setup are not required on modern versions of Windows.
Updates to PowerShell can be accomplished by installing a newer version of the Windows Management Framework.
Other Platforms
PowerShell 6 can be installed on other platforms. The installation packages are available here.
For example, PowerShell 6, for Ubuntu 16.04, is published to package repositories for easy installation (and updates).
To install run the following:
1 2 | # Import the public repository GPG keys curl https: // packages.microsoft.com / keys / microsoft.asc | sudo apt-key add - |
1 2 3 | # Register the Microsoft Ubuntu repository curl https: // packages.microsoft.com / config / ubuntu / 16.04 / prod.list | sudo tee / etc / apt / sources.list.d / microsoft.list |
1 2 | # Update apt-get sudo apt-get update |
1 2 | # Install PowerShell sudo apt-get install -y powershell |
1 2 | # Start PowerShell powershell |
After registering the Microsoft repository once as superuser, from then on, you just need to use sudo apt-get
upgrade powershell to update it. Then just run powershell
1.6: Commenting¶
To comment on power scripts by prepending the line using the # (hash) symbol
1 2 | # This is a comment in PowerShell Get-ChildItem |
You can also have multi-line comments using <# and #at the beginning and end of the comment respectively.
1 2 3 4 5 6 | <# This is a multi-line comment #> Get-ChildItem |
1.7: Creating Objects¶
The New-Object cmdlet is used to create an object.
1 2 | # Create a DateTime object and stores the object in variable "$var" $var = New-Object System.DateTime |
1 2 | # calling constructor with parameters $sr = New-Object System.IO.StreamReader -ArgumentList "file path" |
In many instances, a new object will be created in order to export data or pass it to another commandlet. This can be done like so:
1 2 3 4 5 | $newObject = New-Object -TypeName PSObject -Property @{ ComputerName = "SERVER1" Role = "Interface" Environment = "Production" } |
There are many ways of creating an object. The following method is probably the shortest and fastest way to create a PSCustomObject:
1 2 3 4 5 | $newObject = [PSCustomObject]@{ ComputerName = 'SERVER1' Role = 'Interface' Environment = 'Production' } |
In case you already have an object, but you only need one or two extra properties, you can simply add that property by using Select-Object:
1 2 3 | Get-ChildItem | Select-Object FullName, Name, @{Name='DateTime'; Expression={ Get-Date }}, @{Name='PropertyName'; Expression={'CustomValue'}} |
All objects can be stored in variables or passed into the pipeline. You could also add these objects to a collection and then show the results at the end.
Collections of objects work well with Export-CSV (and Import-CSV). Each line of the CSV is an object, each column a property.
Format commands convert objects into text stream for display. Avoid using Format-* commands until the final step of any data processing, to maintain the usability of the objects.